Doğrulama Uç Noktası

Bu uç noktayı, bir kimlik belgesiyle ilgili belirli ayrıntıları doğrulamak için kullanın. URL'deki {id} kısmını doğrulamak istediğiniz kimlik ID'si ile değiştirin.

Uç Nokta

POST https://app.trustchex.com/api/v1/identifications/{id}/verify

API anahtarınızı x-api-key başlığında ekleyin.

İstek Gövdesi

{
        "type": "DOCUMENT_NUMBER",
        "value": "123456789"
}

Geçerli Türler

• CONTACT_EMAIL: İletişim e-postasını doğrulayın.
• CONTACT_PHONE: İletişim telefon numarasını doğrulayın.
• DOCUMENT_NUMBER: Belge numarasını doğrulayın.
• DOCUMENT_TYPE: Belge türünü doğrulayın. Geçerli değerler:
  • I: Kimlik Kartı
  • P: Pasaport
• DOCUMENT_COUNTRY: Belge ülkesini doğrulayın. ISO 3166-1 alpha-3 kodlarını kullanın (ör. TUR).

Örnek: JavaScript Fetch

fetch(`https://app.trustchex.com/api/v1/identifications/{id}/verify`, {
        method: 'POST',
        headers: {
                'Content-Type': 'application/json',
                'x-api-key': 'API_ANAHTARINIZ',
        },
        body: JSON.stringify({
                type: 'DOCUMENT_NUMBER',
                value: '123456789',
        }),
})
        .then((response) => {
                if (!response.ok) {
                        throw new Error('Ağ yanıtı uygun değil: ' + response.statusText);
                }
                return response.json();
        })
        .then((data) => {
                console.log('Doğrulama Sonucu:', data);
        })
        .catch((error) => {
                console.error('Fetch işlemi başarısız oldu:', error);
        });

Başarılı Yanıt Örneği

{
        "verified": true
}

Önemli Notlar

• Doğrulama yanıtını uygulamanızda uygun şekilde işleyin.
• true yanıtı, sağlanan değerin kimlik belgesindeki ilgili alanla eşleştiğini gösterir.
• false yanıtı, doğrulamanın başarısız olduğunu gösterir.

Hata Yönetimi

Uygulamanız aşağıdaki hataları ele almalıdır:

• 403 Forbidden: API anahtarı eksik veya geçersiz.
• 404 Not Found: Kimlik veya ilgili kaynak bulunamadı.
• 400 Bad Request: Geçersiz istek gövdesi.
• 500 Internal Server Error: Dahili bir sunucu hatası oluştu. Yanıt bir hata mesajı içerecektir.